Resource URL: /platform/<<version=3>>/cloud/pools/<POOL>

    Overview: This resource applies the standard collection item pattern to
              individual OneFS cloud pools. POOL in the resource path is the
              pool name.

     Methods: GET, PUT, DELETE

********************************************************************************

Method GET: Retrieve cloud pool information

       URL: GET /platform/<<version=3>>/cloud/pools/<POOL>

Query arguments:

GET response body schema:
{
  "type": "object", 
  "properties": {
    "pools": {
      "items": {
        "type": "object", 
        "description": "A group of cloud accounts which will be the destination for file stubbing", 
        "properties": {
          "vendor": {
            "type": "string", 
            "description": "A string identifier of the cloud services vendor"
          }, 
          "description": {
            "type": "string", 
            "description": "A brief description of this pool"
          }, 
          "birth_cluster_id": {
            "type": "string", 
            "description": "The guid of the cluster where this pool was created"
          }, 
          "state_details": {
            "type": "string", 
            "description": "Gives further information to describe the state of this pool"
          }, 
          "state": {
            "enum": [
              "OK", 
              "disabled"
            ], 
            "type": "string", 
            "description": "Indicates whether this pool is in a good state (\"OK\") or disabled (\"disabled\")"
          }, 
          "accounts": {
            "items": {
              "type": "string"
            }, 
            "type": "array", 
            "description": "A list of valid names for the accounts in this pool.  There is currently only one account allowed per pool."
          }, 
          "type": {
            "enum": [
              "isilon", 
              "ecs", 
              "virtustream", 
              "azure", 
              "s3", 
              "ran", 
              "ecs2"
            ], 
            "type": "string", 
            "description": "The type of cloud protocol required.  E.g., \"isilon\" for EMC Isilon, \"ecs\" for EMC ECS Appliance, \"virtustream\" for Virtustream Storage Cloud, \"azure\" for Microsoft Azure and \"s3\" for Amazon S3"
          }, 
          "id": {
            "type": "string", 
            "description": "A unique name for this pool"
          }, 
          "name": {
            "type": "string", 
            "description": "A unique name for this pool"
          }
        }
      }, 
      "type": "array"
    }, 
    "resume": {
      "type": [
        "string", 
        "null"
      ], 
      "description": "Continue returning results from previous call using this token (token should come from the previous call, resume cannot be used with other options)."
    }
  }
}

********************************************************************************

Method PUT: Modify a cloud pool.  All fields are optional, but one or more must
            be supplied.

       URL: PUT /platform/<<version=3>>/cloud/pools/<POOL>

There are no query arguments for this method.

PUT request body schema:
{
  "type": "object", 
  "description": "A group of cloud accounts which will be the destination for file stubbing", 
  "properties": {
    "vendor": {
      "type": "string", 
      "description": "A string identifier of the cloud services vendor"
    }, 
    "birth_cluster_id": {
      "type": "string", 
      "description": "The guid of the cluster where this pool was created"
    }, 
    "accounts": {
      "items": {
        "type": "string"
      }, 
      "type": "array", 
      "description": "A list of valid names for the accounts in this pool.  There is currently only one account allowed per pool."
    }, 
    "description": {
      "type": "string", 
      "description": "A brief description of this pool"
    }, 
    "name": {
      "type": "string", 
      "description": "A unique name for this pool"
    }
  }
}

There is no response body for this method.

********************************************************************************

Method DELETE: Delete a cloud pool.

          URL: DELETE /platform/<<version=3>>/cloud/pools/<POOL>

There are no query arguments for this method.

There is no response body for this method.
